Astro supports opt-in, per-page, view transitions with just a few lines of code. View transitions update your page content without the browser’s normal, full-page navigation refresh and provide seamless animations between pages.

Astro provides a routing component that can be added to a single page’s to control page transitions as you navigate away to another page. It provides a lightweight client-side router that intercepts navigation and allows you to customize the transition between pages.

Add this component to a reusable .astro component, such as a common head or layout, for animated page transitions across your entire site (SPA mode).

Astro’s view transitions support is powered by the new View Transitions browser API and also includes:

Note

By default, every page will use regular, full-page, browser navigation. You must opt in to view transitions and can use them either on a per-page basis or site-wide.

Opt in to using view transitions on individual pages by importing and adding the routing component to on every desired page.

Import and add the component to your common or shared layout component. Astro will create default page animations based on the similarities between the old and new page, and will also provide fallback behavior for unsupported browsers.

The example below shows adding Astro’s default page navigation animations site-wide, including the default fallback control option for non-supporting browsers, by importing and adding this component to a Astro component:

No other configuration is necessary to enable Astro’s default client-side navigation!

Use transition directives or override default client-side navigation on individual elements for finer control.

Astro will automatically assign corresponding elements found in both the old page and the new page a shared, unique view-transition-name. This pair of matching elements is inferred by both the type of element and its location in the DOM.

Use optional transition:* directives on page elements in your .astro components for finer control over the page transition behaviour during navigation.

In some cases, you may want or need to identify the corresponding view transition elements yourself. You can specify a name for a pair of elements using the transition:name directive.

Note that the provided transition:name value can only be used once on each page. Set this manually when Astro can’t infer a proper name itself, or for more fine control over matching elements.

You can persist components and HTML elements (instead of replacing them) across page navigations using the transition:persist directive.

For example, the following will continue to play as you navigate to another page that contains the same video element. This works for both forwards and backwards navigation.

You can also place the directive on an Astro island (a UI framework component with a client: directive). If that component exists on the next page, the island from the old page with its current state will continue to be displayed, instead of replacing it with the island from the new page.

In the example below, the count will not be reset when navigating back and forth across pages that contain the component with the transition:persist attribute.

You can also manually identify corresponding elements if the island/element is in a different component between the two pages.

As a convenient shorthand, transition:persist can alternatively take a transition name as a value.

Astro comes with a few built-in animations to override the default fade transition. Add the transition:animate directive to individual elements to customize the behavior of specific transitions.

Combine directives for full control over your page animation. Set a page default on the element, and override on any individual elements as desired.

The example below produces a slide animation for the body content while disabling the browser’s default fade animation for the rest of the page:

You can customize all aspects of a transition with any CSS animation properties.

To customize a built-in animation, first import the animation from astro:transitions, and then pass in customization options.

The example below customizes the duration of the built-in fade animation:

You can also define your own animations for use with transition:animate by defining both the forwards and backwards behavior, as well as new and old pages, according to the following types:

The following example shows all the necessary properties to define a custom fade animation:

Once you have enabled client-side routing on a page by adding the component, every anchor on the page that links to another page on your site will be navigated via client-side routing. There are some cases where you might want to not navigate via CSR. One example is if the link is to any non-page, such as a PDF within your public/ folder. Or an API route that produces an image.

In these cases, you can opt out of client-side routing on a per-link basis using the data-astro-reload attribute like so:

These links will be ignored by the router and a full page navigation will occur.

The router works best in browsers that support View Transitions (i.e. Chromium browsers), but also includes default fallback support for other browsers. Even if the browser does not support the View Transitions API, Astro will still provide in-browser navigation using one of the fallback options for a comparable experience.

You can override Astro’s default fallback support by adding a fallback property on the component and setting it to swap or none:

known limitations

The initial browser animation is not simulated by Astro. So any element using this animation will not currently be animated.

When using the router, the following steps occur to produce Astro’s client-side navigation:

A visitor to your site triggers navigation by any of the following actions:

The router starts fetching the next page.

The router adds the data-astro-transition attribute to the HTML element with a value of 'forward' or 'back' as appropriate.

The router calls document.startViewTransition. This triggers the browser’s own view transition process. Importantly, the browser screenshots the current state of the page.

Inside the startViewTransition callback, the router performs a swap, which consists of the following sequence of events:

The contents of the are swapped out, with some elements kept:

The is completely replaced with the new page’s body.

Elements marked transition:persist are moved over to the new DOM if they exist on the new page.

Scroll position is restored if necessary.

The astro:after-swap event is triggered on the document. This is the end of the swap process.

The router waits for any new stylesheets to load before resolving the transition.

The router executes any new scripts added to the page.

The astro:page-load event fires. This is the end of the navigation process.

When navigating between pages with the component, scripts are run in sequential order to match browser behavior.

If you have code that sets up global state, this state will need to take into account that the script might execute more than once. Check for the global state in your tag, and conditionally execute your code where possible:

Module scripts are only ever executed once because the browser keeps track of which modules are already loaded. For these scripts, you do not need to worry about re-execution.

An event that fires at the end of page navigation, after the new page is visible to the user and blocking styles and scripts are loaded. You can listen to this event on the document.

The component fires this event both on initial page navigation (MPA) and any subsequent navigation, either forwards or backwards.

You can use this event to run code on every page navigation, or only once ever:

An event that fires immediately after the new page replaces the old page. You can listen to this event on the document.

This event is useful to restore any state on the DOM that needs to transfer over to the new page.

For example, if you are implementing dark mode support, this event can be used to restore state across page loads:

Astro’s component includes a CSS media query that disables all view transition animations, including fallback animation, whenever the prefer-reduced-motion setting is detected. Instead, the browser will simply swap the DOM elements without an animation.

View transitions are no longer behind an experimental flag in Astro v3.0.

If you had not enabled this experimental flag in Astro 2.x, this will not cause any breaking changes to your project. The new View Transitions API has no effect on your existing code.

If you were previously using experimental view transitions, there may be some breaking changes when you upgrade your Astro project from an earlier version.

Please follow the instructions below as appropriate to upgrade an Astro v2.x project configured with experimental.viewTransitions: true to v3.0.

If you had previously enabled the experimental flag for view transitions, you will need to update your project for Astro v3.0 which now allows view transitions by default.

Remove the experimental flag:

The component has been moved from astro:components to astro:transitions. Update the import source across all occurrences in your project.

Changed: The transition:animate value morph has been renamed to initial. Also, this is no longer the default animation. If no transition:animate directive is specified, your animations will now default to fade.

Rename any morph animations to intial.

To keep any animations that were previously using morph by default, explicitly add transition:animate="initial"

You can safely remove any animations explicitly set to fade. This is now the default behavior:

Added: Astro also supports a new transition:animate value, none. This value can be used on a page’s element to disable animated full-page transitions on an entire page. This will only override default animation behavior on page elements without an animation directive. You can still set animations on individual elements, and these specific animations will occur.

You may now disable all default transitions on an individual page, animating only elements that explicitly use a transition:animate directive:

The event astro:load has been renamed to astro:page-load. Rename all occurrences in your project.

The event astro:beforeload has been renamed to astro:after-swap. Rename all occurrences in your project.